
<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

    <title>Device type information in LAVA Scheduler &#8212; LAVA 2024.05 documentation</title>
    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/sphinx_highlight.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Detailed device dictionary information in LAVA Scheduler" href="lava-scheduler-device-dictionary.html" />
    <link rel="prev" title="Detailed device information in LAVA Scheduler" href="lava-scheduler-device-help.html" />
    <link rel="canonical" href="https://docs.lavasoftware.org/lava/lava-scheduler-device-type-help.html" />
  
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.12.4.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.4.1/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>


  </head><body>

  <div id="navbar" class="navbar navbar-default navbar-fixed-top">
    <div class="container">
      <div class="navbar-header">
        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html"><span><img src="_static/lava.png"></span>
          LAVA</a>
        <span class="navbar-text navbar-version pull-left"><b>2024.05</b></span>
      </div>

        <div class="collapse navbar-collapse nav-collapse">
          <ul class="nav navbar-nav">
            
                <li><a href="genindex.html">Index</a></li>
                <li><a href="contents.html">Contents</a></li>
            
            
              <li class="dropdown globaltoc-container">
  <a role="button"
     id="dLabelGlobalToc"
     data-toggle="dropdown"
     data-target="#"
     href="index.html">Site <b class="caret"></b></a>
  <ul class="dropdown-menu globaltoc"
      role="menu"
      aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction to LAVA</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="contents.html">Contents</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary of terms</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="support.html">Getting support</a></li>
</ul>
</ul>
</li>
              
                <li class="dropdown">
  <a role="button"
     id="dLabelLocalToc"
     data-toggle="dropdown"
     data-target="#"
     href="#">Page <b class="caret"></b></a>
  <ul class="dropdown-menu localtoc"
      role="menu"
      aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Device type information in LAVA Scheduler</a><ul>
<li><a class="reference internal" href="#static-device-type-information">Static device-type information</a><ul>
<li><a class="reference internal" href="#device-type-template">Device type template</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dynamic-device-type-information">Dynamic device-type information</a></li>
<li><a class="reference internal" href="#device-type-metadata">Device-type metadata</a></li>
<li><a class="reference internal" href="#health-job-summary">Health Job Summary</a></li>
<li><a class="reference internal" href="#devices-overview">Devices Overview</a></li>
<li><a class="reference internal" href="#jobs-for-devices-of-this-type">Jobs for devices of this type</a></li>
</ul>
</li>
</ul>
</ul>
</li>
              
            
            
              
                
  <li>
    <a href="lava-scheduler-device-help.html" title="Previous Chapter: Detailed device information in LAVA Scheduler"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Detailed devi...</span>
    </a>
  </li>
  <li>
    <a href="lava-scheduler-device-dictionary.html" title="Next Chapter: Detailed device dictionary information in LAVA Scheduler"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Detailed devi... &raquo;</span>
    </a>
  </li>
              
            
            
            
            
              <li class="hidden-sm"></li>
            
          </ul>

          
            
<form class="navbar-form navbar-right" action="search.html" method="get">
 <div class="form-group">
  <input type="text" name="q" class="form-control" placeholder="Search" />
 </div>
  <input type="hidden" name="check_keywords" value="yes" />
  <input type="hidden" name="area" value="default" />
</form>
          
        </div>
    </div>
  </div>

<div class="container">
  <div class="row">
    <div class="body col-md-12 content" role="main">
      
  <section id="device-type-information-in-lava-scheduler">
<span id="device-type-help"></span><h1>Device type information in LAVA Scheduler<a class="headerlink" href="#device-type-information-in-lava-scheduler" title="Permalink to this heading">¶</a></h1>
<p>The top of the page is made of three rows: static information, dynamic
information and metadata.</p>
<section id="static-device-type-information">
<h2>Static device-type information<a class="headerlink" href="#static-device-type-information" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p><strong>name</strong> - the unique name of the <a class="reference internal" href="glossary.html#term-device-type"><span class="xref std std-term">device type</span></a>. Used to request a given
device-type in job definitions.
Every user can see a link to the device type template (see <a class="reference internal" href="#device-type-information"><span class="std std-ref">Device type template</span></a>).
Admins can see a link into the <a class="reference internal" href="first-devices.html#django-admin-interface"><span class="std std-ref">Django administration interface</span></a> for this device type.</p></li>
<li><p><strong>Description</strong> - free text field which admins can use to clarify any issues
or notable features / bugs in the hardware. e.g. if hardware floating point
is not enabled when it would otherwise be expected or to clarify the actual
arrangement of cores.</p></li>
<li><p><strong>health-check</strong> - frequency of health checks for all devices of this device type</p></li>
<li><p><strong>aliases</strong> - aliases for this device-type</p></li>
</ul>
<section id="device-type-template">
<span id="device-type-information"></span><span id="index-0"></span><h3>Device type template<a class="headerlink" href="#device-type-template" title="Permalink to this heading">¶</a></h3>
<p>The device type template provides the core configuration for all devices of
this device type and provides methods for certain values to be overridden. The
template can be downloaded, rendered as YAML, for comparison or debugging.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="dispatcher-format.html#override-support"><span class="std std-ref">Overriding values in device type, device dictionary and the job context</span></a></p>
</div>
<p>The available methods and timeouts for this device type are also shown. Not all
devices of this type will support all methods. For example, some methods may
require additional hardware to be fitted like a USB stick or SATA drive.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="actions-boot.html#boot-action"><span class="std std-ref">Boot Action Reference</span></a>, <a class="reference internal" href="actions-deploy.html#deploy-action"><span class="std std-ref">Deploy Action Reference</span></a>, <a class="reference internal" href="timeouts.html#timeouts"><span class="std std-ref">Timeouts</span></a></p>
</div>
</section>
</section>
<section id="dynamic-device-type-information">
<h2>Dynamic device-type information<a class="headerlink" href="#dynamic-device-type-information" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
<li><p>Number of available devices (that can be used by the scheduler) over the number of non-retired devices</p></li>
<li><p>Number of retired devices</p></li>
<li><p>Length of the job queue</p></li>
<li><p>Number of running jobs</p></li>
</ul>
</section>
<section id="device-type-metadata">
<span id="id1"></span><h2>Device-type metadata<a class="headerlink" href="#device-type-metadata" title="Permalink to this heading">¶</a></h2>
<p>Static information about the device type, usually populated by the admins when
the device type is integrated into LAVA.</p>
<ol class="arabic simple">
<li><p><strong>Architecture version</strong> (e.g. ARMv7 or ARMv8) and <strong>Bit width</strong> (eg. 32 or 64)</p></li>
<li><p><strong>Processor Family</strong> (e.g. OMAP4, Exynos)</p></li>
<li><p><strong>CPU model</strong> (often empty but may contain a list of model strings which are
all equivalent within this device type).</p></li>
<li><p><strong>Cores</strong> - a string constructed from the total number of cores specified
and the list of cores selected for this device type. This <strong>does not</strong> infer
that there are equal numbers of the specified cores.</p></li>
</ol>
<p>The information is available as metadata which can later be used in
<a class="reference internal" href="glossary.html#term-query"><span class="xref std std-term">queries</span></a> for <a class="reference internal" href="glossary.html#term-pipeline"><span class="xref std std-term">pipeline</span></a> results as well as providing basic
information on the type of device.</p>
</section>
<section id="health-job-summary">
<h2>Health Job Summary<a class="headerlink" href="#health-job-summary" title="Permalink to this heading">¶</a></h2>
<p>Summary of <a class="reference internal" href="glossary.html#term-health-check"><span class="xref std std-term">health check</span></a> results, number of tests completed or failed
for all devices of this type in the last 24hours, week and month.</p>
</section>
<section id="devices-overview">
<h2>Devices Overview<a class="headerlink" href="#devices-overview" title="Permalink to this heading">¶</a></h2>
<p>Summary of the devices of this type:</p>
<ul class="simple">
<li><p>hostname of each device with an indication of whether the device is
available. (Tests the connection between the server and the dispatcher.)</p></li>
<li><p>name of the dispatcher to which this device is connected.</p></li>
<li><p><a class="reference internal" href="lava-scheduler-device-help.html#device-status"><span class="std std-ref">Device state</span></a></p></li>
<li><p>Restrictions - summary of any restrictions applied to this device and whether
the device is owned by a particular user or group.</p></li>
<li><p>Device health - most recent <a class="reference internal" href="glossary.html#term-health-check"><span class="xref std std-term">health check</span></a> result.</p></li>
</ul>
</section>
<section id="jobs-for-devices-of-this-type">
<h2>Jobs for devices of this type<a class="headerlink" href="#jobs-for-devices-of-this-type" title="Permalink to this heading">¶</a></h2>
<p>A table of all jobs submitted to all devices of the specified <a class="reference internal" href="glossary.html#term-device-type"><span class="xref std std-term">device
type</span></a>, ordered by the most recent submission time.</p>
<p>Note that this differs from the Active Jobs table on the main scheduler which
is ordered by the most recent completion time by default.</p>
</section>
</section>


    </div>
      
  </div>
</div>
<footer class="footer">
  <div class="container">
    <p class="pull-right">
      <a href="#">Back to top</a>
      
    </p>
    <p>
        &copy; Copyright 2010-2019, Linaro Limited.<br/>
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br/>
    </p>
  </div>
</footer>
  </body>
</html>